update

open fun update(deserializedVersion: Int)

Paired with Version annotations to perform needed manual updating of an outdated Config.

If there are breaking changes with a new version of the API, update can be used to perform manual corrections on previous config data or user inputs. For example, if the config has a scale number that was previously a float between 0f-1f, but is now 0f-255f, update could apply a factor to correct the previous user input of 0.5f to 128f.

Author

fzzyhmstrs

Since

0.2.0

Parameters

deserializedVersion

the version of the config read in from File.